home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / include / layout / nsIFormControlFrame.h < prev    next >
C/C++ Source or Header  |  2006-05-08  |  4KB  |  120 lines
  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1998
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37.  
  38. #ifndef nsIFormControlFrame_h___
  39. #define nsIFormControlFrame_h___
  40.  
  41. #include "nsISupports.h"
  42. #include "nsFont.h"
  43. class nsPresContext;
  44. class nsAString;
  45. class nsIContent;
  46. class nsIAtom;
  47.  
  48.  
  49. // IID for the nsIFormControlFrame class
  50. #define NS_IFORMCONTROLFRAME_IID    \
  51.   { 0xf1911a34, 0xcdf7, 0x4f10, \
  52.       { 0xbc, 0x2a, 0x77, 0x1f, 0x68, 0xce, 0xbc, 0x54 } }
  53.  
  54. /** 
  55.   * nsIFormControlFrame is the common interface for frames of form controls. It
  56.   * provides a uniform way of creating widgets, resizing, and painting.
  57.   * @see nsLeafFrame and its base classes for more info
  58.   */
  59. class nsIFormControlFrame : public nsISupports {
  60.  
  61. public:
  62.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IFORMCONTROLFRAME_IID)
  63.  
  64.   NS_IMETHOD_(PRInt32) GetFormControlType() const =  0;
  65.  
  66.   NS_IMETHOD GetName(nsAString* aName) = 0;
  67.  
  68.   virtual void SetFocus(PRBool aOn = PR_TRUE, PRBool aRepaint = PR_FALSE) = 0;
  69.  
  70.   virtual void ScrollIntoView(nsPresContext* aPresContext) = 0;  
  71.  
  72.   /**
  73.    * Set the suggested size for the form element. 
  74.    * This is used to control the size of the element during reflow if it hasn't had it's size
  75.    * explicitly set.
  76.    * @param aWidth width of the form element
  77.    * @param aHeight height of the form element
  78.    * @returns NS_OK 
  79.    */
  80.  
  81.   NS_IMETHOD SetSuggestedSize(nscoord aWidth, nscoord aHeight) = 0;
  82.   
  83.   /**
  84.    * Get the content object associated with this frame. Adds a reference to
  85.    * the content object so the caller must do a release.
  86.    *
  87.    * @see nsISupports#Release()
  88.    */
  89.   NS_IMETHOD GetFormContent(nsIContent*& aContent) const = 0;
  90.  
  91.   /**
  92.    * Set a property on the form control frame.
  93.    *
  94.    * @param aName name of the property to set
  95.    * @param aValue value of the property
  96.    * @returns NS_OK if the property name is valid, otherwise an error code
  97.    */
  98.   
  99.   NS_IMETHOD SetProperty(nsPresContext* aPresContext, nsIAtom* aName, const nsAString& aValue) = 0;
  100.   
  101.   /**
  102.    * Get a property from the form control frame
  103.    *
  104.    * @param aName name of the property to get
  105.    * @param aValue value of the property
  106.    * @returns NS_OK if the property name is valid, otherwise an error code
  107.    */
  108.  
  109.   NS_IMETHOD GetProperty(nsIAtom* aName, nsAString& aValue) = 0; 
  110.  
  111.   /**
  112.    * Notification that the content has been reset
  113.    */
  114.   NS_IMETHOD OnContentReset() = 0;
  115.  
  116. };
  117.  
  118. #endif
  119.  
  120.